Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Added a new Go stdlib authenication template at oss.gg/7_create_a_template.md #2430

Closed
wants to merge 1 commit into from
Closed

feat: Added a new Go stdlib authenication template at oss.gg/7_create_a_template.md #2430

wants to merge 1 commit into from

Conversation

diwasrimal
Copy link

@diwasrimal diwasrimal commented Oct 15, 2024 •
edited by coderabbitai bot
Loading

What does this PR do?

Fixes #2429

Added a Go stdlib template for peforming API authentication using Unkey API keys.

Summary by CodeRabbit

  • New Features
    • Added a side quest for creating templates using the Unkey framework to build APIs.
    • Included requirements for submissions, such as open-source licensing and a README.md file.
    • Expanded the list of existing submissions with a new entry for an API key authentication template using Go's standard library.

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Oct 15, 2024

⚠️ No Changeset found

Latest commit: bfad0e6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel Vercel
Copy link

vercel bot commented Oct 15, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 15, 2024 8:02am

@CLAassistant
Copy link

CLAassistant commented Oct 15, 2024 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@vercel Vercel
Copy link

vercel bot commented Oct 15, 2024

@diwasrimal is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 15, 2024 •
edited
Loading

📝 Walkthrough

Walkthrough

The pull request updates the document oss.gg/7_create_a_template.md by adding a new entry for a side quest focused on creating templates using the Unkey framework to build APIs. It outlines submission requirements, such as the necessity for open-source licensing and a README.md file. Additionally, it includes points awarded for participation and details the proof of submission process. A new entry by Diwas Rimal has also been added, showcasing an API key authentication template using Go's standard library.

Changes

Files Change Summary
oss.gg/7_create_a_template.md Added new entry for a side quest on creating templates with Unkey; included requirements and new submission by Diwas Rimal.

Assessment against linked issues

Objective Addressed Explanation
Create a template of using some framework or language to build an API and protect it with Unkey (2429) ✅
Provide proof that you've completed the task (2429) ✅

Possibly related PRs

Suggested labels

🕹️ oss.gg, :joystick: 750 points, hacktoberfest

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • MichaelUnkey
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4913147 and bfad0e6.

📒 Files selected for processing (1)
  • oss.gg/7_create_a_template.md (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
oss.gg/7_create_a_template.md (1)

42-42: New entry looks good, but let's verify a few things.

The new entry follows the correct format and aligns with the PR objectives. However, let's verify a few important points:

  1. The entry doesn't appear to be a duplicate, but we should confirm this.
  2. We need to verify if the linked repository meets all the requirements specified in the side quest.

Let's run some checks:

This script will help us verify:

  1. There are no duplicates in the file.
  2. The linked repository exists and is accessible.
  3. The repository contains a LICENSE file (to check if it's open source and MIT licensed).
  4. The repository has a README.md file.
  5. The README.md file contains a quickstart guide.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added Needs Approval Needs approval from Unkey 🕹️ oss.gg labels Oct 15, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 15, 2024 •
edited
Loading

Thank you for following the naming conventions for pull request titles! 🙏

@diwasrimal diwasrimal changed the title Updated oss.gg/7_create_a_template.md feat: Added a new Go stdlib authenication template at oss.gg/7_create_a_template.md Oct 15, 2024
@chronark
Copy link
Collaborator

already awarded points on the issue

@chronark chronark closed this Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@perkinsjr perkinsjr Awaiting requested review from perkinsjr perkinsjr is a code owner

@chronark chronark Awaiting requested review from chronark chronark is a code owner

@mcstepp mcstepp Awaiting requested review from mcstepp mcstepp is a code owner

@MichaelUnkey MichaelUnkey Awaiting requested review from MichaelUnkey MichaelUnkey is a code owner

Assignees
No one assigned
Labels
Needs Approval Needs approval from Unkey 🕹️ oss.gg
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[oss.gg hackathon] Go stdlib API authenication example with unkey
3 participants
@diwasrimal @CLAassistant @chronark